Summary of Changes

Hello @ardatan, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a significant new feature: the ability for the GraphQL router to report detailed usage metrics to the GraphQL Hive Console. This integration provides valuable insights into how the router is being used, including operation names, execution times, and error rates. The reporting mechanism is highly configurable, allowing users to control aspects like sampling rates, excluded operations, and reporting intervals, ensuring efficient and relevant data collection. This enhancement is crucial for monitoring and optimizing GraphQL API performance and adoption.

Highlights

• Hive Console Usage Reporting Integration: The router now integrates with the hive-console-client to report GraphQL operation usage data, providing insights into router activity.
• Configurable Usage Settings: A new UsageConfig struct has been introduced, allowing detailed configuration of reporting parameters such as API token, endpoint, sample rate, excluded operations, client headers, buffer size, and various timeouts.
• Dynamic Usage Agent Initialization and Background Task: A UsageAgent is initialized based on the provided UsageConfig and registered as a background task, ensuring that usage reports are periodically flushed to the Hive Console.
• GraphQL Pipeline Integration: The GraphQL execution pipeline has been modified to capture operation details, execution duration, and error counts, which are then conditionally sent to the UsageAgent for reporting.
• Dependency Updates and Forked Parser: The project's dependencies have been updated, notably replacing the graphql-parser crate with graphql-parser-hive-fork across Cargo.lock and Cargo.toml files, and adding new crates like md5 and webpki-roots.
• Error Counting in Execution Output: The PlanExecutionOutput now includes an error_count field, which tracks the number of errors encountered during query plan execution, providing crucial data for usage reporting.

🐋 This PR was built and pushed to the following Docker images:

Image Names: ghcr.io/graphql-hive/router

Platforms: linux/amd64,linux/arm64

Image Tags: ghcr.io/graphql-hive/router:pr-499 ghcr.io/graphql-hive/router:sha-f37f916

{
"buildx.build.ref": "builder-3120460a-6daa-42e0-a588-a96b5a30c41a/builder-3120460a-6daa-42e0-a588-a96b5a30c41a0/zxdo7heuqk99hrrp7r3fqyph5",
"containerimage.descriptor": {
  "mediaType": "application/vnd.oci.image.index.v1+json",
  "digest": "sha256:543ce52f3909f85c94da6848507319c6eae02efe51b57a5175d25e84a0a82f22",
  "size": 1609
},
"containerimage.digest": "sha256:543ce52f3909f85c94da6848507319c6eae02efe51b57a5175d25e84a0a82f22",
"image.name": "ghcr.io/graphql-hive/router:pr-499,ghcr.io/graphql-hive/router:sha-f37f916"
}

✅ k6-benchmark results

     ✓ response code was 200
     ✓ no graphql errors
     ✓ valid response structure

     █ setup

     checks.........................: 100.00% ✓ 208554      ✗ 0    
     data_received..................: 6.1 GB  203 MB/s
     data_sent......................: 82 MB   2.7 MB/s
     http_req_blocked...............: avg=3.29µs   min=711ns   med=1.86µs  max=5.93ms   p(90)=2.68µs  p(95)=3.09µs  
     http_req_connecting............: avg=407ns    min=0s      med=0s      max=1.51ms   p(90)=0s      p(95)=0s      
     http_req_duration..............: avg=21.09ms  min=2.28ms  med=20.2ms  max=102.1ms  p(90)=28.68ms p(95)=31.79ms 
       { expected_response:true }...: avg=21.09ms  min=2.28ms  med=20.2ms  max=102.1ms  p(90)=28.68ms p(95)=31.79ms 
     http_req_failed................: 0.00%   ✓ 0           ✗ 69538
     http_req_receiving.............: avg=150.11µs min=26.62µs med=40.98µs max=70.84ms  p(90)=90.21µs p(95)=407.67µs
     http_req_sending...............: avg=25.78µs  min=5.5µs   med=10.87µs max=19.49ms  p(90)=16.49µs p(95)=28.66µs 
     http_req_tls_handshaking.......: avg=0s       min=0s      med=0s      max=0s       p(90)=0s      p(95)=0s      
     http_req_waiting...............: avg=20.91ms  min=2.23ms  med=20.07ms max=71.01ms  p(90)=28.41ms p(95)=31.41ms 
     http_reqs......................: 69538   2312.532982/s
     iteration_duration.............: avg=21.57ms  min=6.09ms  med=20.56ms max=238.48ms p(90)=29.11ms p(95)=32.27ms 
     iterations.....................: 69518   2311.867869/s
     vus............................: 50      min=50        max=50 
     vus_max........................: 50      min=50        max=50 

One more thing, I think we might need to expose these by default using env vars. See env_var_override for example on how to do it. We can align to how it looks like in GW.

🐋 This PR was built and pushed to the following Docker images:

Image Names: ghcr.io/graphql-hive/router

Platforms: linux/amd64,linux/arm64

Image Tags: ghcr.io/graphql-hive/router:pr-499 ghcr.io/graphql-hive/router:sha-d3137bd

{
"buildx.build.ref": "builder-0a57fbca-71a0-4126-9659-7217f530a7e3/builder-0a57fbca-71a0-4126-9659-7217f530a7e30/ranv4tc6bij4laa7shw15zsml",
"containerimage.descriptor": {
  "mediaType": "application/vnd.oci.image.index.v1+json",
  "digest": "sha256:86fcff9bca36d44282ba78f246eca15e260b6980e6d59259209b844be2e2ed63",
  "size": 1609
},
"containerimage.digest": "sha256:86fcff9bca36d44282ba78f246eca15e260b6980e6d59259209b844be2e2ed63",
"image.name": "ghcr.io/graphql-hive/router:pr-499,ghcr.io/graphql-hive/router:sha-d3137bd"
}